home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / DEFAULTOBSERVABLE.PY < prev    next >
Encoding:
Python Source  |  2000-11-10  |  9.5 KB  |  281 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. __doc__="""Implement Observable interface (see
  86. http://www.zope.org/Members/michel/Projects/Interfaces/ObserverAndNotification)
  87. This class is intended to be used as a mixin (note that it doesn't derive
  88. from any Zope persistence classes, for instance).
  89.  
  90. $Id: DefaultObservable.py,v 1.2.2.1 2000/11/10 16:55:41 tseaver Exp $"""
  91.  
  92. __version__='$Revision: 1.2.2.1 $'[11:-2]
  93.  
  94. import string
  95. from types import StringType
  96.  
  97. class DefaultObservable:
  98.     """
  99.     See the Interfaces wiki for design notes:
  100.  
  101. http://www.zope.org/Members/michel/Projects/Interfaces/ObserverAndNotification
  102.  
  103.     DefaultObservable is intended to be used as a mix-in, like so::
  104.  
  105.         from OFS.SimpleItem import SimpleItem
  106.         from OFS.DefaultObservable import DefaultObservable
  107.  
  108.         class Foo( SimpleItem, DefaultObservable ):
  109.             '''
  110.                 Some foo or other
  111.             '''
  112.             ...
  113.             def bar( self, ... ):
  114.                 '''
  115.                 '''
  116.                 ...
  117.                 self.notify( "bar" )
  118.  
  119.     Clients register with a Foo instance using the methods of the
  120.     Observable interface, e.g.::
  121.  
  122.         foo.registerObserver( self.getPhysicalPath() + ( 'watchFoo',) )
  123.  
  124.     When the Foo instance has its 'bar()' method called, it will
  125.     notify all registered observers, passing 'bar' as the event;  in
  126.     this case, the client's 'watchFoo()' method will be called, with
  127.     the foo object and 'bar' passed as parameters.
  128.     """
  129.  
  130.     def __init__( self, debug=0 ):
  131.         self._observers = []
  132.         self._debug = debug
  133.     
  134.     def _normalize( self, observer ):
  135.  
  136.         # Assert that observer is a string or a sequence of strings.
  137.         if type( observer ) != StringType:
  138.             observer = string.join( observer, '/' ) 
  139.  
  140.         return observer
  141.  
  142.     #
  143.     #   Observable interface methods.
  144.     #
  145.     def registerObserver( self, observer ):
  146.  
  147.         normal = self._normalize( observer )
  148.         if self.restrictedTraverse( normal, None ):
  149.             self._observers.append( normal )
  150.         else:
  151.             raise NameError, observer
  152.  
  153.     def unregisterObserver( self, observer ):
  154.  
  155.         self._observers.remove( self._normalize( observer ) )
  156.  
  157.     #
  158.     #   Convenience method for derivatives.
  159.     #
  160.     def notify( self, event=None ):
  161.  
  162.         bozos = []
  163.  
  164.         for observer in self._observers:
  165.  
  166.             obj = self.restrictedTraverse( observer, None )
  167.  
  168.             if obj is not None:
  169.                 try:
  170.                     obj( self, event )
  171.                 except:
  172.                     bozos.append( observer ) # Veto not allowed!
  173.                     if self._debug:
  174.                         import traceback
  175.                         traceback.print_exc()
  176.             else:
  177.                 bozos.append( observer )
  178.             
  179.         for bozo in bozos:
  180.             try: # avoid race condition if unregister() called before now
  181.                 self._observers.remove( bozo )
  182.             except:
  183.                 pass
  184.         
  185.  
  186. #
  187. #   Unit tests
  188. #
  189.  
  190. if __name__ == '__main__':
  191.  
  192.     class DontGoHere( Exception ): pass
  193.         
  194.     class TestSubject( DefaultObservable ):
  195.  
  196.         def __init__( self, paths ):
  197.             DefaultObservable.__init__( self, 0 )
  198.             self.paths = paths
  199.  
  200.         def restrictedTraverse( self, path, default ):
  201.             return self.paths.get( path, default )
  202.  
  203.     callbacks = {}
  204.  
  205.     def recordCallback( name, subject, event ):
  206.         cbrec = callbacks.get( name, None )
  207.         if cbrec is None:
  208.             cbrec = callbacks[ name ] = []
  209.         cbrec.append( ( subject, event ) )
  210.         
  211.  
  212.     class TestObserver:
  213.  
  214.         def __call__( self, subject, event ):
  215.             recordCallback( 'direct', subject, event )
  216.         
  217.         def namedCallback( self, subject, event ):
  218.             recordCallback( 'named', subject, event )
  219.         
  220.         def named2Callback( self, subject, event ):
  221.             recordCallback( 'named2', subject, event )
  222.         
  223.         def boundCallback( self, subject, event ):
  224.             recordCallback( 'bound', subject, event )
  225.  
  226.     def freefuncObserver( subject, event ):
  227.         recordCallback( 'freefunc', subject, event ) 
  228.     
  229.     def tryVeto( subject, event ):
  230.         """ Simulate attempted veto. """
  231.         raise 'Idawanna!'
  232.     
  233.     observer = TestObserver()
  234.  
  235.     # Simulate Zope's path traversal mechanism.
  236.     paths = {}
  237.     paths[ 'direct'         ] = observer
  238.     paths[ 'direct/named'   ] = observer.namedCallback
  239.     paths[ 'direct/named2'  ] = observer.named2Callback
  240.     paths[ 'bound'          ] = observer.boundCallback
  241.     paths[ 'freefunc'       ] = freefuncObserver
  242.     paths[ 'tryVeto'        ] = tryVeto
  243.  
  244.     subject = TestSubject( paths )
  245.  
  246.     subject.registerObserver( 'direct' )
  247.     subject.registerObserver( 'bound' )
  248.     subject.registerObserver( 'direct/named' )
  249.     subject.registerObserver( ( 'direct', 'named2' ) )
  250.     subject.registerObserver( 'freefunc' )
  251.     subject.registerObserver( 'tryVeto' )
  252.  
  253.     try:
  254.         subject.registerObserver( 'nonesuch' )
  255.         raise DontGoHere( 'path not found' )
  256.     except NameError:
  257.         pass
  258.     except:
  259.         import traceback
  260.         traceback.print_exc()
  261.  
  262.     try:
  263.         subject.registerObserver( 3.1415926 )
  264.         raise DontGoHere( 'non-path' )
  265.     except TypeError:
  266.         pass
  267.     except:
  268.         import traceback
  269.         traceback.print_exc()
  270.  
  271.     subject.notify( 'First event' )
  272.  
  273.     subject.unregisterObserver( 'bound' )
  274.     subject.notify( { 'name' : 'Second event', 'value' : 42 } )
  275.  
  276.     for key in callbacks.keys():
  277.         print '[%s]' % key
  278.         for cb in callbacks[ key ]:
  279.             print '    %s' % `cb`
  280.  
  281.